﻿// Copyright (c) 2010-2014 SharpDX - Alexandre Mutel
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace SharpDX.Toolkit.Input
{
    /// <summary>
    /// Provides access to platform-independent pointer events
    /// </summary>
    public interface IPointerService
    {
        /// <summary>
        /// Gets the current state of the pointer
        /// </summary>
        /// <returns>An instance of <see cref="PointerState"/> class</returns>
        PointerState GetState();

        /// <summary>
        /// Fills the provided object with the current pointer state information
        /// </summary>
        /// <remarks>All properties of provided object will be cleared.</remarks>
        /// <param name="state">The object that needs to be filled with pointer information</param>
        /// <exception cref="ArgumentNullException">Is thrown when <paramref name="state"/> is null</exception>
        void GetState(PointerState state);
    }
}